<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Home In Manchester</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description_mc" content="">
<meta name="author" content="">

<!-- Le styles -->
<link href="assets/css/bootstrap.css" rel="stylesheet">
<link href="assets/css/bootstrap-responsive.css" rel="stylesheet">
<link href="assets/css/docs.css" rel="stylesheet">
<link href="assets/js/google-code-prettify/prettify.css"
	rel="stylesheet">

<!-- Le HTML5 shim, for IE6-8 support of HTML5 elements -->
<!--[if lt IE 9]>
      <script src="assets/js/html5shiv.js"></script>
    <![endif]-->

<style>
body {
	font-family: 微软雅黑;
	font-size: 14px;
}

.nav-list {
	margin-top: 0px;
}

h4 {
	margin-top: 25px;
}
</style>
</head>

<body data-spy="scroll" data-target=".bs-docs-sidebar">

	<!-- Navbar
    ================================================== -->
	<div class="navbar navbar-inverse navbar-fixed-top">
		<div class="navbar-inner">
			<div class="container">
				<button type="button" class="btn btn-navbar" data-toggle="collapse"
					data-target=".nav-collapse">
					<span class="icon-bar"></span> <span class="icon-bar"></span> <span
						class="icon-bar"></span>
				</button>
				<div class="nav-collapse collapse">
					<ul class="nav">
						<li class=""><a href="index.html">首页</a></li>
						<li class=""><a href="live.html">生活信息</a></li>
						<li class=""><a href="func.html">实用功能</a></li>
						<li class=""><a href="forum.html">娱乐交友</a></li>
						<li class=""><a href="study.html">学术讨论</a></li>
						<li class=""><a href="member.html">会员管理</a></li>
						<li class=""><a href="bookFood.html">订餐系统</a></li>
						<li class=""><a href="ticket.html">票务系统</a></li>
						<li class="active"><a href="coupon.html">优惠券</a></li>
						<li class=""><a href="readme.html">补充说明</a></li>
						<li class=""><a href="extend.html">扩展功能</a></li>
						<li class=""><a href="advert.html">广告</a></li>
						<li class=""><a href="report.html">公告系统</a></li>
						<li class=""><a href="radio.html">电台系统</a></li>
					</ul>
				</div>
			</div>
		</div>
	</div>

	<!-- Subhead
================================================== -->
	<header class="jumbotron subhead" id="overview">
		<div class="container">
			<h1>客户端接口调用指南</h1>
			<p class="lead">web客户端、移动客户端获取和设置服务器数据的统一接口访问规范。符合restful的api设计范式，提供跨平台的基于http协议的一致web接口。</p>
		</div>
	</header>


	<div class="container">

		<!-- Docs nav
    ================================================== -->
		<div class="row">
			<div class="span3 bs-docs-sidebar">
				<h3>优惠券客户端API</h3>
				<ul class="nav nav-list bs-docs-sidenav">
					<li><a href="#getCouponSorts"><i class="icon-chevron-right"></i>
							查询优惠券分类</a></li>
					<li><a href="#getSellers"><i class="icon-chevron-right"></i>
							查询商户信息</a></li>
					<li><a href="#getAddresses"><i class="icon-chevron-right"></i>
							查询商户地址信息</a></li>
					<li><a href="#getCoupons"><i class="icon-chevron-right"></i>
							查询优惠券信息</a></li>
					<li><a href="#myCouponBag"><i class="icon-chevron-right"></i>
							查看我的卡包</a></li>
					<li><a href="#receiveCoupon"><i class="icon-chevron-right"></i>
							领取优惠券</a></li>
					<li><a href="#useCoupon"><i class="icon-chevron-right"></i>
							使用优惠券</a></li>
				</ul>
				
				
			</div>
			<div class="span9">

				<!-- Typography
        ================================================== -->
				

				<!-- Code
        ================================================== -->
				<section id="getCouponSorts">
					<div class="page-header">
						<h1>获取优惠券分类信息API</h1>
					</div>
					<h3>1 功能说明</h3>
					<p>可以通过该处接口获取系统中所有的优惠券分类，如酒店、商场、旅游等等。</p>
					
					<br></br>
					<h3>2 接口调用说明</h3>
					<h4>2.1 URL</h4>
					<p>正式环境：http://[域名]/api/coupon/sorts</p>
					<p>测试环境：http://115.29.250.136:8080/homeInManchester/api/coupon/sorts</p>
					<h4>2.2 返回格式</h4>
					<p>json</p>
					<h4>2.3 http请求方式</h4>
					<p>GET</p>
					<h4>2.4 参数说明</h4>
					<p>
						(1) 公共参数 。详情可以参考 <a href="index.html#public_args">公共参数说明</a>
					</p>
					<p>(2) 私有参数。无。</p>

					<h4>2.5 请求示例</h4>
					<code>http://115.29.250.136:8080/homeInManchester/api/coupon/sorts</code>

					<h4>2.6 返回参数说明</h4>
					<table class="table table-bordered">
						<thead>
							<tr>
								<th width="120">参数名称</th>
								<th width="100">类型</th>
								<th>含义说明</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>menuId</td>
								<td>Long</td>
								<td>优惠券分类唯一标识。</td>
							</tr>
							<tr>
								<td>menuParent</td>
								<td>Long</td>
								<td>上级分类ID，如果没有上级菜单，默认值为0.</td>
							</tr>
							<tr>
								<td>sellerId</td>
								<td>Long</td>
								<td>所属商家的ID。优惠券系统中无商家概念，故此处值为0.</td>
							</tr>
							<tr>
								<td>menuNum</td>
								<td>Integer</td>
								<td>排列序号。</td>
							</tr>
							<tr>
								<td>menuName</td>
								<td>String</td>
								<td>分类名称</td>
							</tr>
							<tr>
								<td>taste</td>
								<td>String</td>
								<td>口味。订餐系统中应用， 此处无意义。</td>
							</tr>
							<tr>
								<td>menuDesc</td>
								<td>String</td>
								<td>分类其他信息描述。</td>
							</tr>
						</tbody>
					</table>
					
					<h4 >2.7 错误返回码说明</h4>
					<p>公共错误返回码：参考 ： <a href="index.html#public-code">公共返回码说明</a> 。 </p>
					<p>私有错误返回码：暂无。</p>
					
					<h4>2.8 正确返回示例：</h4>
						
						<pre>
[
    {
        "sellerId": 0, 
        "menuId": 93, 
        "menuParent": 0, 
        "menuCode": ":0:", 
        "menuName": "酒店", 
        "menuNum": 1, 
        "menuPic": null, 
        "taste": null, 
        "menuDesc": "", 
        "type": 2, 
        "children": [ ]
    }, 
    {
        "sellerId": 0, 
        "menuId": 94, 
        "menuParent": 0, 
        "menuCode": ":0:", 
        "menuName": "商场", 
        "menuNum": 2, 
        "menuPic": null, 
        "taste": null, 
        "menuDesc": "", 
        "type": 2, 
        "children": [ ]
    }, 
    {
        "sellerId": 0, 
        "menuId": 95, 
        "menuParent": 0, 
        "menuCode": ":0:", 
        "menuName": "旅游景点", 
        "menuNum": 3, 
        "menuPic": null, 
        "taste": null, 
        "menuDesc": "", 
        "type": 2, 
        "children": [ ]
    }
]
</pre>
					<h4>2.9 错误返回示例</h4>
					<pre>
{
	"code":1000,
	"msg":"网络错误，http请求异常。"
}
					</pre>
					
					
				</section>
				
				<section id="getSellers">
					<div class="page-header">
						<h1>查询优惠券所属商户API</h1>
					</div>
					
					<h3>1 功能说明</h3>
					<p>获取全部的商户信息，为优惠券的所有者（比如超市、商场、酒店等等）。</p>
					
					<br></br>
					<h3>2 接口调用说明</h3>
					<h4>2.1 URL</h4>
					<p>正式环境：http://[域名]/api/coupon/sellers</p>
					<p>测试环境：http://115.29.250.136:8080/homeInManchester/api/coupon/sellers</p>
					<h4>2.2  返回格式</h4>
					<p>json</p>
					<h4>2.3 http请求方式</h4>
					<p>GET 或 POST</p>
					<h4>2.4 参数说明</h4>
					<p>(1) 公共参数 。详情可以参考 <a href="index.html#public_args">公共参数说明</a></p>
					<p>(2) 私有参数。</p>
					<table class="table table-bordered">
						<thead>
							<tr>
								<th width="120">参数名称</th>
								<th width="100">是否必填</th>
								<th width="100">类型</th>
								<th>含义说明</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>search</td>
								<td>否</td>
								<td>String</td>
								<td>搜索关键字:优惠券所属商户名称，支持模糊查询。</td>
							</tr>
							<tr>
								<td>sortId</td>
								<td>否</td>
								<td>Integer</td>
								<td>所属优惠券分类ID。</td>
							</tr>
							<tr>
								<td>pageNum</td>
								<td>否</td>
								<td>Integer</td>
								<td>分页参数，第几页，默认为第一页。</td>
							</tr>
							<tr>
								<td>numPerPage</td>
								<td>否</td>
								<td>Integer</td>
								<td>每页信息条数，默认为8条。</td>
							</tr>
						</tbody>
					</table>
					
					<h4>2.5 请求示例</h4>
					<code>http://115.29.250.136:8080/homeInManchester/api/coupon/sellers</code>
					
					<h4>2.6 返回参数说明</h4>
					<p>请求成功，会返回商家的列表信息。</p>
					<table class="table table-bordered">
						<thead>
							<tr>
								<th width="120">参数名称</th>
								<th width="100">类型</th>
								<th>含义说明</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>numPerPage</td>
								<td>Integer</td>
								<td>每页显示条数。</td>
							</tr>
							<tr>
								<td>pageNum</td>
								<td>Integer</td>
								<td>当前第几页。</td>
							</tr>
							<tr>
								<td>totalCount</td>
								<td>Integer</td>
								<td>总条数。</td>
							</tr>
							<tr>
								<td>totalPage</td>
								<td>Integer</td>
								<td>总页数。</td>
							</tr>
							<tr>
								<td>result</td>
								<td>Object[]</td>
								<td>商户信息列表集合，具体返回参数说明参考下面<a href="#result">《result的具体返回参数说明》</a></td>
							</tr>
						</tbody>
					</table>
					<p id="result"><strong>result的具体返回参数说明</strong></p>
					<table class="table table-bordered">
						<thead>
							<tr>
								<th width="120">参数名称</th>
								<th width="100">类型</th>
								<th>含义说明</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>sellerId</td>
								<td>Integer</td>
								<td>商户唯一标识。</td>
							</tr>
							<tr>
								<td>name</td>
								<td>String</td>
								<td>商户名称。</td>
							</tr>
							<tr>
								<td>link</td>
								<td>String</td>
								<td>联系方式。</td>
							</tr>
							<tr>
								<td>description_mc</td>
								<td>String</td>
								<td>商户描述。</td>
							</tr>
							<tr>
								<td>sortId</td>
								<td>Integer</td>
								<td>所属优惠券分类。</td>
							</tr>
							<tr>
								<td>createDate</td>
								<td>String</td>
								<td>创建日期</td>
							</tr>
							<tr>
								<td>updateDate</td>
								<td>String</td>
								<td>更新日期</td>
							</tr>
							<tr>
								<td>thumbnail</td>
								<td>String</td>
								<td>商户缩略图。只有图片的名称+后缀，如：643a0021-2a44-461f-af13-cdfa5889d471.jpg。具体显示可以加前缀：http://网址+上下文+/resources/fileupload/+thumbnail</td>
							</tr>
							<tr>
								<td>addresses</td>
								<td>String</td>
								<td>地址列表。改API不会请求到具体的地址列表，具体可以根据商户ID获取地址列表。</td>
							</tr>
						</tbody>
					</table>
					
					<h4 >2.7 错误返回码说明</h4>
					<p>公共错误返回码：参考 ： <a href="index.html#public-code">公共返回码说明</a> 。 </p>
					<p>私有错误返回码：暂无。</p>
					
					<h4>2.8 正确返回示例：</h4>
						
						<pre>
{
    "result": [
        {
            "link": "31", 
            "userId": 0, 
            "sortId": 93, 
            "sortName": "酒店", 
            "sellerId": 4, 
            "addresses": null, 
            "updateDate": null, 
            "thumbnail": "31b5a9fb-97b8-4b9f-8575-7142a5f869ad.jpg", 
            "createDate": null, 
            "name": "睡沙发沙发沙发", 
            "description_mc": "斯蒂芬斯蒂芬"
        }, 
        {
            "link": "1213213", 
            "userId": 0, 
            "sortId": 94, 
            "sortName": "商场", 
            "sellerId": 3, 
            "addresses": null, 
            "updateDate": null, 
            "thumbnail": "137a657b-2741-48b8-89b2-f9ef14ef4883.jpg", 
            "createDate": null, 
            "name": "银河大酒店", 
            "description_mc": "斯蒂芬说分手方式"
        }, 
        {
            "link": "123131", 
            "userId": 0, 
            "sortId": 93, 
            "sortName": "酒店", 
            "sellerId": 1, 
            "addresses": null, 
            "updateDate": null, 
            "thumbnail": "643a0021-2a44-461f-af13-cdfa5889d471.jpg", 
            "createDate": null, 
            "name": "世界风打击丢按", 
            "description_mc": "三分三"
        }
    ], 
    "pageNum": 1, 
    "numPerPage": 10, 
    "totalPage": 1, 
    "totalCount": 3
}
</pre>
					<h4>2.9 错误返回示例</h4>
					<pre>
{
	"code":1000,
	"msg":"网络错误，http请求异常。"
}
					</pre>
					
					
				</section>
				
				<section id="getAddresses">
					<div class="page-header">
						<h1>获取商户的地址列表API</h1>
					</div>
					<h3>1 功能说明</h3>
					<p>一般一个商户可以有多个地址，如大型连锁超市，旅游公司等等。</p>
					
					<br></br>
					<h3>2 接口调用说明</h3>
					<h4>2.1 URL</h4>
					<p>正式环境：http://[域名]/api/coupon/seller/addresses</p>
					<p>测试环境：http://115.29.250.136:8080/homeInManchester/api/coupon/seller/addresses</p>
					<h4>2.2 返回格式</h4>
					<p>json</p>
					<h4>2.3 http请求方式</h4>
					<p>GET</p>
					<h4>2.4 参数说明</h4>
					<p>
						(1) 公共参数 。详情可以参考 <a href="index.html#public_args">公共参数说明</a>
					</p>
					<p>(2) 私有参数。</p>
					<table class="table table-bordered">
						<thead>
							<tr>
								<th width="120">参数名称</th>
								<th width="100">是否必填</th>
								<th width="100">类型</th>
								<th>含义说明</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>sellerId</td>
								<td>是</td>
								<td>Integer</td>
								<td>商户唯一标识。</td>
							</tr>
						</tbody>
					</table>

					<h4>2.5 请求示例</h4>
					<code>http://115.29.250.136:8080/homeInManchester/api/coupon/seller/addresses?sellerId=4</code>

					<h4>2.6 返回参数说明</h4>
					<p>请求成功，会返回商户地址的列表信息。</p>
					
					<table class="table table-bordered">
						<thead>
							<tr>
								<th width="120">参数名称</th>
								<th width="100">类型</th>
								<th>含义说明</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>sellerId</td>
								<td>Integer</td>
								<td>商户唯一标识。</td>
							</tr>
							<tr>
								<td>addressId</td>
								<td>Integer</td>
								<td>地址唯一标识。</td>
							</tr>
							<tr>
								<td>tel</td>
								<td>String</td>
								<td>联系电话。</td>
							</tr>
							<tr>
								<td>postCode</td>
								<td>String</td>
								<td>邮编。</td>
							</tr>
							<tr>
								<td>address</td>
								<td>String</td>
								<td>地址。</td>
							</tr>
							
						</tbody>
					</table>

					<h4>2.7 错误返回码说明</h4>
					<p>
						公共错误返回码：参考 ： <a href="index.html#public-code">公共返回码说明</a> 。
					</p>
					<p>私有错误返回码：无。</p>
					

					<h4>2.8 正确返回示例：</h4>
					<code>http://115.29.250.136:8080/homeInManchester/api/coupon/seller/addresses?sellerId=4</code>
					<pre>
[
    {
        "sellerId": 4, 
        "tel": "1231", 
        "postCode": "收复失地", 
        "addressId": 4, 
        "address": "1121"
    }, 
    {
        "sellerId": 4, 
        "tel": "123", 
        "postCode": "1231", 
        "addressId": 5, 
        "address": "三分三"
    }
]
						</pre>



					<h4>2.9 错误返回示例</h4>
					<pre>
{"msg":"会员未登录，无权限访问！","object":null,"code":"2000"}	
					</pre>


				</section>
				
				<section id="getCoupons">
					<div class="page-header">
						<h1>查询优惠券API</h1>
					</div>
					
					<h3>1 功能说明</h3>
					<p>获取全部的优惠券信息。</p>
					
					<br></br>
					<h3>2 接口调用说明</h3>
					<h4>2.1 URL</h4>
					<p>正式环境：http://[域名]/api/coupon/coupons</p>
					<p>测试环境：http://115.29.250.136:8080/homeInManchester/api/coupon/coupons</p>
					<h4>2.2  返回格式</h4>
					<p>json</p>
					<h4>2.3 http请求方式</h4>
					<p>GET ， POST</p>
					<h4>2.4 参数说明</h4>
					<p>(1) 公共参数 。详情可以参考 <a href="index.html#public_args">公共参数说明</a></p>
					<p>(2) 私有参数。</p>
					<table class="table table-bordered">
						<thead>
							<tr>
								<th width="120">参数名称</th>
								<th width="100">是否必填</th>
								<th width="100">类型</th>
								<th>含义说明</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>name</td>
								<td>否</td>
								<td>String</td>
								<td>根据优惠券名称，支持模糊查询。</td>
							</tr>
							<tr>
								<td>sortId</td>
								<td>否</td>
								<td>Integer</td>
								<td>所属优惠券分类ID。</td>
							</tr>
							<tr>
								<td>sellerId</td>
								<td>否</td>
								<td>Integer</td>
								<td>所属优惠券商户ID。</td>
							</tr>
							<tr>
								<td>pageNum</td>
								<td>否</td>
								<td>Integer</td>
								<td>分页参数，第几页，默认为第一页。</td>
							</tr>
							<tr>
								<td>numPerPage</td>
								<td>否</td>
								<td>Integer</td>
								<td>每页信息条数，默认为8条。</td>
							</tr>
						</tbody>
					</table>
					
					<h4>2.5 请求示例</h4>
					<code>http://115.29.250.136:8080/homeInManchester/api/coupon/coupons?sellerId=3</code>
					
					<h4>2.6 返回参数说明</h4>
					<p>请求成功，会返回优惠券的列表信息。</p>
					<table class="table table-bordered">
						<thead>
							<tr>
								<th width="120">参数名称</th>
								<th width="100">类型</th>
								<th>含义说明</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>numPerPage</td>
								<td>Integer</td>
								<td>每页显示条数。</td>
							</tr>
							<tr>
								<td>pageNum</td>
								<td>Integer</td>
								<td>当前第几页。</td>
							</tr>
							<tr>
								<td>totalCount</td>
								<td>Integer</td>
								<td>总条数。</td>
							</tr>
							<tr>
								<td>totalPage</td>
								<td>Integer</td>
								<td>总页数。</td>
							</tr>
							<tr>
								<td>result</td>
								<td>Object[]</td>
								<td>优惠券信息列表集合，具体返回参数说明参考下面<a href="#result">《result的具体返回参数说明》</a></td>
							</tr>
						</tbody>
					</table>
					<p id="result"><strong>result的具体返回参数说明</strong></p>
					<table class="table table-bordered">
						<thead>
							<tr>
								<th width="120">参数名称</th>
								<th width="100">类型</th>
								<th>含义说明</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>sortId</td>
								<td>Integer</td>
								<td>所属分类唯一标识。</td>
							</tr>
							<tr>
								<td>sortName</td>
								<td>String</td>
								<td>所属分类名称。</td>
							</tr>
							<tr>
								<td>sellerId</td>
								<td>Integer</td>
								<td>所属商户唯一标识。</td>
							</tr>
							<tr>
								<td>sellerName</td>
								<td>String</td>
								<td>所属商户名称。</td>
							</tr>
							<tr>
								<td>couponId</td>
								<td>Integer</td>
								<td>优惠券唯一标识。</td>
							</tr>
							<tr>
								<td>name</td>
								<td>String</td>
								<td>优惠券名称。</td>
							</tr>
							<tr>
								<td>publishDate</td>
								<td>String</td>
								<td>发行日期。</td>
							</tr>
							<tr>
								<td>endDate</td>
								<td>String</td>
								<td>截止日期。</td>
							</tr>
							<tr>
								<td>description_mc</td>
								<td>String</td>
								<td>优惠券简要描述。</td>
							</tr>
							<tr>
								<td>totalCount</td>
								<td>Integer</td>
								<td>优惠券发行总量。</td>
							</tr>
							<tr>
								<td>count</td>
								<td>Integer</td>
								<td>优惠券被领取量。</td>
							</tr>
							<tr>
								<td>thumbnail</td>
								<td>String</td>
								<td>优惠券缩略图。只有图片的名称+后缀，如：643a0021-2a44-461f-af13-cdfa5889d471.jpg。具体显示可以加前缀：http://网址+上下文+/resources/fileupload/+thumbnail</td>
							</tr>
							<tr>
								<td>pictures</td>
								<td>String</td>
								<td>优惠券展示图。多个图片中间用逗号隔开，如：643a0021-2a44-461f-af13-cdfa5889d471.jpg,743a0021-2a44-461f-af13-cdfa5889d471.png</td>
							</tr>
							<tr>
								<td>type</td>
								<td>Integer</td>
								<td>优惠券种类。0标识日领取优惠券，1标识限量领取。限量领取类型的优惠券，在领取时，需要到商场输入领取密码。</td>
							</tr>
							<tr>
								<td>password</td>
								<td>String</td>
								<td>当优惠券种类为限量领取时，即当type=1时，需要输入此密码才可以领取。</td>
							</tr>
							<tr class="info">
								<td>praiseBaseCount</td>
								<td>Integer</td>
								<td>点赞基数，此数据只有在后台设置有效。
								&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
								<strong><font color=red>更新时间：2014-09-21</font></strong>
								</td>
							</tr>
							<tr class="info">
								<td>praiseCount</td>
								<td>Integer</td>
								<td>点赞总数，该数据为所有评论者点赞累加后，再加上点赞基数之和。
								
								<strong><font color=red>更新时间：2014-09-21</font></strong>
								</td>
							</tr>
							<tr class="info">
								<td>commentBaseCount</td>
								<td>Integer</td>
								<td>评论基数，此数据只有在后台设置有效。
								&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
								<strong><font color=red>更新时间：2014-09-21</font></strong>
								</td>
							</tr>
							<tr class="info">
								<td>commentCount</td>
								<td>Integer</td>
								<td>总评论数，该数据为所有评论者评论累加后，再加上评论基数之和。
								<strong><font color=red>更新时间：2014-09-21</font></strong>
								</td>
							</tr>
						</tbody>
					</table>
					
					<h4 >2.7 错误返回码说明</h4>
					<p>公共错误返回码：参考 ： <a href="index.html#public-code">公共返回码说明</a> 。 </p>
					<p>私有错误返回码：暂无。</p>
					
					<h4>2.8 正确返回示例：</h4>
						
						<pre>
{
    "result": [
        {
            "sortId": 94, 
            "sortName": "商场", 
            "sellerId": 3, 
            "publishDate": "2014-08-07", 
            "endDate": "", 
            "couponId": 2, 
            "details": null, 
            "totalCount": 12, 
            "sellerName": "银河大酒店", 
            "thumbnail": "e839f8d6-d45c-43e2-a086-d6d2903e95bb.jpg", 
            "pictures": "10d4a2c8-0af0-418a-b42b-1b788b9cccd2.jpg", 
            "name": "师德师风", 
            "type": 1, 
            "count": 0, 
            "description_mc": "爽身粉", 
            "password": "123123"
        }, 
        {
            "sortId": 94, 
            "sortName": "商场", 
            "sellerId": 3, 
            "publishDate": "", 
            "endDate": "", 
            "couponId": 3, 
            "details": null, 
            "totalCount": 0, 
            "sellerName": "银河大酒店", 
            "thumbnail": "", 
            "pictures": "", 
            "name": "师德师风", 
            "type": 0, 
            "count": 0, 
            "description_mc": "", 
            "password": ""
        }, 
        {
            "sortId": 94, 
            "sortName": "商场", 
            "sellerId": 3, 
            "publishDate": "2014-08-21", 
            "endDate": "2014-09-20", 
            "couponId": 5, 
            "details": null, 
            "totalCount": 100, 
            "sellerName": "银河大酒店", 
            "thumbnail": "2a86f356-7e5b-4d86-818d-eaa7398954e2.jpg", 
            "pictures": "3c2dd24e-d424-48ca-ace4-1778e14b03e9.jpg,c4b8dc40-3b7e-40a8-861c-0826e0216395.jpg", 
            "name": "早餐票", 
            "type": 0, 
            "count": 0, 
            "description_mc": "凭此票，可以提供免费早餐。", 
            "password": ""
        }
    ], 
    "pageNum": 1, 
    "numPerPage": 8, 
    "totalPage": 1, 
    "totalCount": 3
}
</pre>
					<h4>2.9 错误返回示例</h4>
					<pre>
{
	"code":1000,
	"msg":"网络错误，http请求异常。"
}
					</pre>
					
					
				</section>
				
				
				<section id="myCouponBag">
					<div class="page-header">
						<h1>获取我的卡包信息API</h1>
					</div>
					<h3>1 功能说明</h3>
					<p>此处可以查询查看自己当前卡包内的优惠券列表、卡包容量等信息。</p>
					
					<br></br>
					<h3>2 接口调用说明</h3>
					<h4>2.1 URL</h4>
					<p>正式环境：http://[域名]/api/coupon/bag/coupons</p>
					<p>测试环境：http://115.29.250.136:8080/homeInManchester/api/coupon/bag/coupons</p>
					<h4>2.2 返回格式</h4>
					<p>json</p>
					<h4>2.3 http请求方式</h4>
					<p>GET</p>
					<h4>2.4 参数说明</h4>
					<p>
						(1) 公共参数 。详情可以参考 <a href="index.html#public_args">公共参数说明</a>
					</p>
					<p>(2) 私有参数。</p>
					<table class="table table-bordered">
						<thead>
							<tr>
								<th width="120">参数名称</th>
								<th width="100">是否必填</th>
								<th width="100">类型</th>
								<th>含义说明</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>name</td>
								<td>否</td>
								<td>String</td>
								<td>根据优惠券名称，支持模糊查询。</td>
							</tr>
							<tr>
								<td>sortId</td>
								<td>否</td>
								<td>Integer</td>
								<td>所属优惠券分类ID。</td>
							</tr>
							<tr>
								<td>sellerId</td>
								<td>否</td>
								<td>Integer</td>
								<td>所属优惠券商户ID。</td>
							</tr>
							<tr>
								<td>pageNum</td>
								<td>否</td>
								<td>Integer</td>
								<td>分页参数，第几页，默认为第一页。</td>
							</tr>
							<tr>
								<td>numPerPage</td>
								<td>否</td>
								<td>Integer</td>
								<td>每页信息条数，默认为8条。</td>
							</tr>
						</tbody>
					</table>

					<h4>2.5 请求示例</h4>
					<code>http://115.29.250.136:8080/homeInManchester/api/coupon/bag/coupons</code>

					<h4>2.6 返回参数说明</h4>
					<p>请求成功，会返回优惠券的列表信息。</p>
					<table class="table table-bordered">
						<thead>
							<tr>
								<th width="120">参数名称</th>
								<th width="100">类型</th>
								<th>含义说明</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>numPerPage</td>
								<td>Integer</td>
								<td>每页显示条数。</td>
							</tr>
							<tr>
								<td>pageNum</td>
								<td>Integer</td>
								<td>当前第几页。</td>
							</tr>
							<tr>
								<td>totalCount</td>
								<td>Integer</td>
								<td>总条数。</td>
							</tr>
							<tr>
								<td>totalPage</td>
								<td>Integer</td>
								<td>总页数。</td>
							</tr>
							<tr>
								<td>result</td>
								<td>Object[]</td>
								<td>优惠券信息列表集合，具体返回参数说明参考下面<a href="#result">《result的具体返回参数说明》</a></td>
							</tr>
						</tbody>
					</table>
					<p id="result"><strong>result的具体返回参数说明</strong></p>
					<table class="table table-bordered">
						<thead>
							<tr>
								<th width="120">参数名称</th>
								<th width="100">类型</th>
								<th>含义说明</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>sortId</td>
								<td>Integer</td>
								<td>所属分类唯一标识。</td>
							</tr>
							<tr>
								<td>sortName</td>
								<td>String</td>
								<td>所属分类名称。</td>
							</tr>
							<tr>
								<td>sellerId</td>
								<td>Integer</td>
								<td>所属商户唯一标识。</td>
							</tr>
							<tr>
								<td>sellerName</td>
								<td>String</td>
								<td>所属商户名称。</td>
							</tr>
							<tr>
								<td>couponId</td>
								<td>Integer</td>
								<td>优惠券唯一标识。</td>
							</tr>
							<tr>
								<td>name</td>
								<td>String</td>
								<td>优惠券名称。</td>
							</tr>
							<tr>
								<td>publishDate</td>
								<td>String</td>
								<td>发行日期。</td>
							</tr>
							<tr>
								<td>endDate</td>
								<td>String</td>
								<td>截止日期。</td>
							</tr>
							<tr>
								<td>description_mc</td>
								<td>String</td>
								<td>优惠券简要描述。</td>
							</tr>
							<tr>
								<td>totalCount</td>
								<td>Integer</td>
								<td>优惠券发行总量。</td>
							</tr>
							<tr>
								<td>count</td>
								<td>Integer</td>
								<td>优惠券被领取量。</td>
							</tr>
							<tr>
								<td>thumbnail</td>
								<td>String</td>
								<td>优惠券缩略图。只有图片的名称+后缀，如：643a0021-2a44-461f-af13-cdfa5889d471.jpg。具体显示可以加前缀：http://网址+上下文+/resources/fileupload/+thumbnail</td>
							</tr>
							<tr>
								<td>pictures</td>
								<td>String</td>
								<td>优惠券展示图。多个图片中间用逗号隔开，如：643a0021-2a44-461f-af13-cdfa5889d471.jpg,743a0021-2a44-461f-af13-cdfa5889d471.png</td>
							</tr>
							<tr>
								<td>type</td>
								<td>Integer</td>
								<td>优惠券种类。0标识日领取优惠券，1标识限量领取。限量领取类型的优惠券，在领取时，需要到商场输入领取密码。</td>
							</tr>
							<tr>
								<td>password</td>
								<td>String</td>
								<td>当优惠券种类为限量领取时，即当type=1时，需要输入此密码才可以领取。</td>
							</tr>
							<tr>
								<td>status</td>
								<td>Integer</td>
								<td>优惠券使用状态。0标识已领取未使用，1标识已使用。</td>
							</tr>
						</tbody>
					</table>

					<h4>2.7 错误返回码说明</h4>
					<p>
						公共错误返回码：参考 ： <a href="index.html#public-code">公共返回码说明</a> 。
					</p>
					<p>私有错误返回码：无。</p>
					

					<h4>2.8 正确返回示例：</h4>
					<code>http://115.29.250.136:8080/homeInManchester/api/coupon/bag/coupons</code>
					<pre>
{
    "result": [
        {
            "sortId": 94, 
            "sortName": "商场", 
            "sellerId": 3, 
            "publishDate": "2014-08-07", 
            "endDate": "", 
            "couponId": 2, 
            "details": null, 
            "totalCount": 12, 
            "sellerName": "银河大酒店", 
            "thumbnail": "e839f8d6-d45c-43e2-a086-d6d2903e95bb.jpg", 
            "pictures": "10d4a2c8-0af0-418a-b42b-1b788b9cccd2.jpg", 
            "name": "师德师风", 
            "type": 1, 
            "count": 0, 
            "description_mc": "爽身粉", 
            "password": "123123", 
            "status": 0
        }, 
        {
            "sortId": 94, 
            "sortName": "商场", 
            "sellerId": 3, 
            "publishDate": "", 
            "endDate": "", 
            "couponId": 3, 
            "details": null, 
            "totalCount": 0, 
            "sellerName": "银河大酒店", 
            "thumbnail": "", 
            "pictures": "", 
            "name": "师德师风", 
            "type": 0, 
            "count": 0, 
            "description_mc": "", 
            "password": "", 
            "status": 0
        }, 
        {
            "sortId": 94, 
            "sortName": "商场", 
            "sellerId": 3, 
            "publishDate": "2014-08-21", 
            "endDate": "2014-09-20", 
            "couponId": 5, 
            "details": null, 
            "totalCount": 100, 
            "sellerName": "银河大酒店", 
            "thumbnail": "2a86f356-7e5b-4d86-818d-eaa7398954e2.jpg", 
            "pictures": "3c2dd24e-d424-48ca-ace4-1778e14b03e9.jpg,c4b8dc40-3b7e-40a8-861c-0826e0216395.jpg", 
            "name": "早餐票", 
            "type": 0, 
            "count": 0, 
            "description_mc": "凭此票，可以提供免费早餐。", 
            "password": "", 
            "status": 0
        }
    ], 
    "pageNum": 1, 
    "numPerPage": 8, 
    "totalPage": 1, 
    "totalCount": 3
}
						</pre>



					<h4>2.9 错误返回示例</h4>
					<pre>
{"msg":"会员未登录！","object":null,"code":"2000"}	
					</pre>


				</section>
				
				<section id="receiveCoupon">
					<div class="page-header">
						<h1>领取优惠券API</h1>
					</div>
					<h3>1 功能说明</h3>
					<p>注册用户登录后，可以通过系统领取优惠券（将优惠券加入卡包内）。</p>

					<br></br>
					<h3>2 接口调用说明</h3>
					<h4>2.1 URL</h4>
					<p>正式环境：</p>
					<p>
						<code>http://[域名]/api/coupon/receive</code>
					</p>

					<p>测试环境：将[域名]替换为：115.29.250.136:8080/homeInManchester</p>

					<h4>2.2 返回格式</h4>
					<p>json</p>
					<h4>2.3 http请求方式</h4>
					<p>POST,GET</p>
					<h4>2.4 参数说明</h4>
					<p>
						(1) 公共参数 。详情可以参考 <a href="index.html#public_args">公共参数说明</a>
					</p>
					<p>(2) 私有参数。</p>
					
					<table class="table table-bordered">
						<thead>
							<tr>
								<th width="120">参数名称</th>
								<th width="100">是否必填</th>
								<th width="100">类型</th>
								<th>含义说明</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>couponId</td>
								<td>必填</td>
								<td>Integer</td>
								<td>领取的优惠券唯一标识。</td>
							</tr>
							<tr>
								<td>password</td>
								<td>选填</td>
								<td>String</td>
								<td>如果优惠券类型为限量领取，则需要输入密码。</td>
							</tr>
						</tbody>
					</table>
					

					<h4>2.5 请求示例</h4>
					<p>
						<code>http://115.29.250.136:8080/homeInManchester/api/coupon/receive</code>
					</p>

					<h4>2.6 返回参数说明</h4>
					<p>请求正确的话，会成功返回{"value":"true"}。不正确的话，会返回错误码，见2.7说明。</p>

					<h4>2.7 错误返回码说明</h4>
					<p>
						公共错误返回码：参考 ： <a href="index.html#public-code">公共返回码说明</a> 。
					</p>
					<p>私有错误返回码：</p>
					<table class="table table-bordered">
						<thead>
							<tr>
								<th width="120">返回码（code）</th>
								<th width="100">返回信息(msg)</th>
								<th>含义说明</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>2000</td>
								<td>会员未登录！</td>
								<td>未登录用户无权限操作。</td>
							</tr>
							<tr>
								<td>4001</td>
								<td>已领取</td>
								<td>登录会员一人只能领取一次。</td>
							</tr>
							<tr>
								<td>4002</td>
								<td>卡包已满</td>
								<td>领取优惠券总量不能超过该用户卡包容量。</td>
							</tr>
							<tr>
								<td>4003</td>
								<td>需要输入密码</td>
								<td>领取限量版优惠券需要输入密码。</td>
							</tr>
							<tr>
								<td>4004</td>
								<td>密码错误</td>
								<td>限量版优惠券领取时密码输入错误。</td>
							</tr>
						</tbody>
					</table>

					<h4>2.8 正确返回示例：</h4>
					
					<p>
						请求http地址为：
						<code>http://115.29.250.136:8080/homeInManchester/api/coupon/receive?couponId=5</code>
					</p>
					<p>正确返回：</p>
					<pre>
{
    "value": "true"
}
					</pre>


					<h4>2.9 错误返回示例</h4>

					<pre>
{"msg":"已领取","object":null,"code":"4001"}	
				</pre>

				</section>
				
				<section id="useCoupon">
					<div class="page-header">
						<h1>使用优惠券API</h1>
					</div>
					<h3>1 功能说明</h3>
					<p>注册用户登录后，可以通过系统领取优惠券，并使用。</p>

					<br></br>
					<h3>2 接口调用说明</h3>
					<h4>2.1 URL</h4>
					<p>正式环境：</p>
					<p>
						<code>http://[域名]/api/coupon/use</code>
					</p>

					<p>测试环境：将[域名]替换为：115.29.250.136:8080/homeInManchester</p>

					<h4>2.2 返回格式</h4>
					<p>json</p>
					<h4>2.3 http请求方式</h4>
					<p>POST,GET</p>
					<h4>2.4 参数说明</h4>
					<p>
						(1) 公共参数 。详情可以参考 <a href="index.html#public_args">公共参数说明</a>
					</p>
					<p>(2) 私有参数。</p>
					
					<table class="table table-bordered">
						<thead>
							<tr>
								<th width="120">参数名称</th>
								<th width="100">是否必填</th>
								<th width="100">类型</th>
								<th>含义说明</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>couponId</td>
								<td>必填</td>
								<td>Integer</td>
								<td>优惠券唯一标识。</td>
							</tr>
						</tbody>
					</table>
					

					<h4>2.5 请求示例</h4>
					<p>
						<code>http://115.29.250.136:8080/homeInManchester/api/coupon/use</code>
					</p>

					<h4>2.6 返回参数说明</h4>
					<p>请求正确的话，会成功返回{"value":"true"}。不正确的话，会返回错误码，见2.7说明。</p>

					<h4>2.7 错误返回码说明</h4>
					<p>
						公共错误返回码：参考 ： <a href="index.html#public-code">公共返回码说明</a> 。
					</p>
					<p>私有错误返回码：</p>
					<table class="table table-bordered">
						<thead>
							<tr>
								<th width="120">返回码（code）</th>
								<th width="100">返回信息(msg)</th>
								<th>含义说明</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>2000</td>
								<td>会员未登录！</td>
								<td>未登录用户无权限操作。</td>
							</tr>
						</tbody>
					</table>

					<h4>2.8 正确返回示例：</h4>
					
					<p>
						请求http地址为：
						<code>http://115.29.250.136:8080/homeInManchester/api/coupon/use?couponId=5</code>
					</p>
					<p>正确返回：</p>
					<pre>
{
    "value": "true"
}
					</pre>


					<h4>2.9 错误返回示例</h4>

					<pre>
{"msg":"会员未登录","object":null,"code":"2000"}	
				</pre>

				</section>
				
			</div>
		</div>

	</div>



	<!-- Footer
    ================================================== -->
	<footer class="footer">
		<div class="container">
			<p>
				Designed and built with all the love in the world by <a
					href="http://www.hcrazy.com" target="_blank">@hsmart</a>
			</p>
			<ul class="footer-links">
				<li><a href="http://www.hcrazy.com">Blog</a></li>
				<li class="muted">&middot;</li>
				<li><a href="http://www.hcrazy.com">Issues</a></li>
				<li class="muted">&middot;</li>
				<li><a href="http://www.hcrazy.com">Changelog</a></li>
			</ul>
		</div>
	</footer>



	<!-- Le javascript
    ================================================== -->
	<!-- Placed at the end of the document so the pages load faster -->
	<script src="assets/js/jquery.js"></script>
	<script src="assets/js/bootstrap-transition.js"></script>
	<script src="assets/js/bootstrap-alert.js"></script>
	<script src="assets/js/bootstrap-modal.js"></script>
	<script src="assets/js/bootstrap-dropdown.js"></script>
	<script src="assets/js/bootstrap-scrollspy.js"></script>
	<script src="assets/js/bootstrap-tab.js"></script>
	<script src="assets/js/bootstrap-tooltip.js"></script>
	<script src="assets/js/bootstrap-popover.js"></script>
	<script src="assets/js/bootstrap-button.js"></script>
	<script src="assets/js/bootstrap-collapse.js"></script>
	<script src="assets/js/bootstrap-carousel.js"></script>
	<script src="assets/js/bootstrap-typeahead.js"></script>
	<script src="assets/js/bootstrap-affix.js"></script>

	<script src="assets/js/holder/holder.js"></script>
	<script src="assets/js/google-code-prettify/prettify.js"></script>

	<script src="assets/js/application.js"></script>



</body>
</html>
